home *** CD-ROM | disk | FTP | other *** search
/ IRIX 6.2 Development Libraries / SGI IRIX 6.2 Development Libraries.iso / dist / complib.idb / usr / share / catman / p_man / cat3 / complib / cgbrfs.z / cgbrfs
Text File  |  1996-03-14  |  6KB  |  199 lines

  1.  
  2.  
  3.  
  4. CCCCGGGGBBBBRRRRFFFFSSSS((((3333FFFF))))                                                          CCCCGGGGBBBBRRRRFFFFSSSS((((3333FFFF))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      CGBRFS - improve the computed solution to a system of linear equations
  10.      when the coefficient matrix is banded, and provides error bounds and
  11.      backward error estimates for the solution
  12.  
  13. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  14.      SUBROUTINE CGBRFS( TRANS, N, KL, KU, NRHS, AB, LDAB, AFB, LDAFB, IPIV, B,
  15.                         LDB, X, LDX, FERR, BERR, WORK, RWORK, INFO )
  16.  
  17.          CHARACTER      TRANS
  18.  
  19.          INTEGER        INFO, KL, KU, LDAB, LDAFB, LDB, LDX, N, NRHS
  20.  
  21.          INTEGER        IPIV( * )
  22.  
  23.          REAL           BERR( * ), FERR( * ), RWORK( * )
  24.  
  25.          COMPLEX        AB( LDAB, * ), AFB( LDAFB, * ), B( LDB, * ), WORK( *
  26.                         ), X( LDX, * )
  27.  
  28. PPPPUUUURRRRPPPPOOOOSSSSEEEE
  29.      CGBRFS improves the computed solution to a system of linear equations
  30.      when the coefficient matrix is banded, and provides error bounds and
  31.      backward error estimates for the solution.
  32.  
  33.  
  34. AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  35.      TRANS   (input) CHARACTER*1
  36.              Specifies the form of the system of equations:
  37.              = 'N':  A * X = B     (No transpose)
  38.              = 'T':  A**T * X = B  (Transpose)
  39.              = 'C':  A**H * X = B  (Conjugate transpose)
  40.  
  41.      N       (input) INTEGER
  42.              The order of the matrix A.  N >= 0.
  43.  
  44.      KL      (input) INTEGER
  45.              The number of subdiagonals within the band of A.  KL >= 0.
  46.  
  47.      KU      (input) INTEGER
  48.              The number of superdiagonals within the band of A.  KU >= 0.
  49.  
  50.      NRHS    (input) INTEGER
  51.              The number of right hand sides, i.e., the number of columns of
  52.              the matrices B and X.  NRHS >= 0.
  53.  
  54.      AB      (input) COMPLEX array, dimension (LDAB,N)
  55.              The original band matrix A, stored in rows 1 to KL+KU+1.  The j-
  56.              th column of A is stored in the j-th column of the array AB as
  57.              follows:  AB(ku+1+i-j,j) = A(i,j) for max(1,j-
  58.              ku)<=i<=min(n,j+kl).
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. CCCCGGGGBBBBRRRRFFFFSSSS((((3333FFFF))))                                                          CCCCGGGGBBBBRRRRFFFFSSSS((((3333FFFF))))
  71.  
  72.  
  73.  
  74.      LDAB    (input) INTEGER
  75.              The leading dimension of the array AB.  LDAB >= KL+KU+1.
  76.  
  77.      AFB     (input) COMPLEX array, dimension (LDAFB,N)
  78.              Details of the LU factorization of the band matrix A, as computed
  79.              by CGBTRF.  U is stored as an upper triangular band matrix with
  80.              KL+KU superdiagonals in rows 1 to KL+KU+1, and the multipliers
  81.              used during the factorization are stored in rows KL+KU+2 to
  82.              2*KL+KU+1.
  83.  
  84.      LDAFB   (input) INTEGER
  85.              The leading dimension of the array AFB.  LDAFB >= 2*KL*KU+1.
  86.  
  87.      IPIV    (input) INTEGER array, dimension (N)
  88.              The pivot indices from CGBTRF; for 1<=i<=N, row i of the matrix
  89.              was interchanged with row IPIV(i).
  90.  
  91.      B       (input) COMPLEX array, dimension (LDB,NRHS)
  92.              The right hand side matrix B.
  93.  
  94.      LDB     (input) INTEGER
  95.              The leading dimension of the array B.  LDB >= max(1,N).
  96.  
  97.      X       (input/output) COMPLEX array, dimension (LDX,NRHS)
  98.              On entry, the solution matrix X, as computed by CGBTRS.  On exit,
  99.              the improved solution matrix X.
  100.  
  101.      LDX     (input) INTEGER
  102.              The leading dimension of the array X.  LDX >= max(1,N).
  103.  
  104.      FERR    (output) REAL array, dimension (NRHS)
  105.              The estimated forward error bound for each solution vector X(j)
  106.              (the j-th column of the solution matrix X).  If XTRUE is the true
  107.              solution corresponding to X(j), FERR(j) is an estimated upper
  108.              bound for the magnitude of the largest element in (X(j) - XTRUE)
  109.              divided by the magnitude of the largest element in X(j).  The
  110.              estimate is as reliable as the estimate for RCOND, and is almost
  111.              always a slight overestimate of the true error.
  112.  
  113.      BERR    (output) REAL array, dimension (NRHS)
  114.              The componentwise relative backward error of each solution vector
  115.              X(j) (i.e., the smallest relative change in any element of A or B
  116.              that makes X(j) an exact solution).
  117.  
  118.      WORK    (workspace) COMPLEX array, dimension (2*N)
  119.  
  120.      RWORK   (workspace) REAL array, dimension (N)
  121.  
  122.      INFO    (output) INTEGER
  123.              = 0:  successful exit
  124.              < 0:  if INFO = -i, the i-th argument had an illegal value
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. CCCCGGGGBBBBRRRRFFFFSSSS((((3333FFFF))))                                                          CCCCGGGGBBBBRRRRFFFFSSSS((((3333FFFF))))
  137.  
  138.  
  139.  
  140. PPPPAAAARRRRAAAAMMMMEEEETTTTEEEERRRRSSSS
  141.      ITMAX is the maximum number of steps of iterative refinement.
  142.  
  143.  
  144.  
  145.  
  146.  
  147.  
  148.  
  149.  
  150.  
  151.  
  152.  
  153.  
  154.  
  155.  
  156.  
  157.  
  158.  
  159.  
  160.  
  161.  
  162.  
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.